Inscoper::Status¶

Status class represents a state of the system. More...

#include <Status.h>

Public Functions¶

	Name
	Status() Default constructor.
	Status(const std::vector< Inscoper::StatusParamPtr > & statusParams, const std::vector< std::string > & tags) Constructor with parameters and tags.
	Status(const std::shared_ptr< Status > & status, bool copy =false) Copy constructor.
	~Status() Destructor.
void	fromXML(Inscoper::XMLNode & xml) Load from XML.
void	toXML(Inscoper::XMLNode & xmlParent) Save to XML.
void	setStatus(const std::shared_ptr< Status > & status, bool copy =false) Update status content.
std::vector< Inscoper::StatusParamPtr >	getParamList() Get the status parameter list.
Inscoper::StatusParamPtr	getParam(const Inscoper::SubDeviceId & subDeviceId) Get the status parameter by sub-device ID.
bool	hasParamValue(const Inscoper::SubDeviceId & subDeviceId) Check if the status parameter has a value.
std::string	getParamStringValue(const Inscoper::SubDeviceId & subDeviceId) Get string value.
unsigned char	getParamUnsignedCharValue(const Inscoper::SubDeviceId & subDeviceId) Get unsigned char value.
char	getParamCharValue(const Inscoper::SubDeviceId & subDeviceId) Get char value.
unsigned short	getParamUnsignedShortValue(const Inscoper::SubDeviceId & subDeviceId) Get unsigned short value.
short	getParamShortValue(const Inscoper::SubDeviceId & subDeviceId) Get short value.
unsigned int	getParamUnsignedIntValue(const Inscoper::SubDeviceId & subDeviceId) Get unsigned int value.
int	getParamIntValue(const Inscoper::SubDeviceId & subDeviceId) Get int value.
unsigned long long int	getParamUnsignedLongValue(const Inscoper::SubDeviceId & subDeviceId) Get unsigned long long value.
long long int	getParamLongValue(const Inscoper::SubDeviceId & subDeviceId) Get long long value.
float	getParamFloatValue(const Inscoper::SubDeviceId & subDeviceId) Get float value.
double	getParamDoubleValue(const Inscoper::SubDeviceId & subDeviceId) Get double value.
Inscoper::EParamType	getValueType(const Inscoper::SubDeviceId & subDeviceId) Get value type.
const std::vector< std::string > &	getTags() const Get tag list.
void	addTag(const std::string & tag) Add a tag.
void	addTags(const std::vector< std::string > & tagList) Add multiple tags.
void	addParam(const Inscoper::SubDeviceId & subDeviceId) Add status parameter without value.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, const std::string & value) Add string status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, unsigned char value) Add unsigned char status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, char value) Add char status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short value) Add unsigned short status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, short value) Add short status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int value) Add unsigned int status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, int value) Add int status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, unsigned long long int value) Add unsigned long long status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, long long int value) Add long long status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, float value) Add float status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, double value) Add double status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, bool value) Add boolean status parameter.
void	addParam(const Inscoper::SubDeviceId & subDeviceId, const char * value) Add C-string status parameter.
void	addParam(const Inscoper::StatusParamPtr & newParam) Add existing status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, const std::string & value) Add tagged string status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, unsigned char value) Add tagged unsigned char status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, char value) Add tagged char status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, unsigned short value) Add tagged unsigned short status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, short value) Add tagged short status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, unsigned int value) Add tagged unsigned int status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, int value) Add tagged int status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, unsigned long long int value) Add tagged unsigned long long status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, long long int value) Add tagged long long status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, float value) Add tagged float status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, double value) Add tagged double status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, bool value) Add tagged boolean status parameter.
void	addMultiParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, const char * value) Add tagged C-string status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, const std::string & value) Add indexed tagged string status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, unsigned char value) Add indexed tagged unsigned char status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, char value) Add indexed tagged char status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, unsigned short value) Add indexed tagged unsigned short parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, short value) Add indexed tagged short status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, unsigned int value) Add indexed tagged unsigned int status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, int value) Add indexed tagged int status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, unsigned long long int value) Add indexed tagged unsigned long long status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, long long int value) Add indexed tagged long long status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, float value) Add indexed tagged float status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, double value) Add indexed tagged double status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, bool value) Add indexed tagged boolean status parameter.
void	addMultiParam(unsigned short index, const Inscoper::SubDeviceId & subDeviceId, unsigned short tag, const char * value) Add indexed tagged C-string status parameter.
bool	containsParam(const Inscoper::SubDeviceId & subDeviceId) Check if status parameter exists.
void	removeParam(const Inscoper::SubDeviceId & subDeviceId) Remove status parameter.
virtual bool	equals(const std::shared_ptr< Status > & other) Check equality.
virtual size_t	getHash() Get hash.
std::shared_ptr< Core::InternalStatus >	getInternal() Get internal object.

Detailed Description¶

class Inscoper::Status;

Status class represents a state of the system.

A Status object encapsulates the state of the microscope and other devices at a particular moment. It manages a list of status parameters, which are key-value pairs associating a sub-device with a value. It also maintains a list of tags used for sequence generation with recipes.

Public Functions Documentation¶

function Status¶

Status()

Default constructor.

Initializes a new instance of the Status class.

function Status¶

Status(
    const std::vector< Inscoper::StatusParamPtr > & statusParams,
    const std::vector< std::string > & tags
)

Constructor with parameters and tags.

Parameters:

statusParams : The list of status parameter objects
tags : The list of tags

Initializes a new instance of the Status class with a list of parameters and tags.

function Status¶

Status(
    const std::shared_ptr< Status > & status,
    bool copy =false
)

Copy constructor.

Parameters:

status : The source Status object
copy : If true, performs a deep copy, otherwise status parameters are shared with the source (default: false)

Exceptions:

InscoperException If an error occurs during copy

Creates a new instance of the Status class from an existing one, optionally performing a deep copy.

function ~Status¶

~Status()

Destructor.

function fromXML¶

void fromXML(
    Inscoper::XMLNode & xml
)

Load from XML.

Parameters:

xml : The XML node containing status information

Exceptions:

InscoperException If an error occurs

Populates the status information from an XML node.

function toXML¶

void toXML(
    Inscoper::XMLNode & xmlParent
)

Save to XML.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException If an error occurs

Exports the status information to an XML node attached to the parent node.

function setStatus¶

void setStatus(
    const std::shared_ptr< Status > & status,
    bool copy =false
)

Update status content.

Parameters:

status : The source status
copy : If true, performs a deep copy, otherwise status parameters are shared with the source (default: false)

Exceptions:

InscoperException If an error occurs

Updates this status with the content of another status.

function getParamList¶

std::vector< Inscoper::StatusParamPtr > getParamList()

Get the status parameter list.

Return: The list of status parameters

Retrieves the list of all status parameters in this status.

function getParam¶

Inscoper::StatusParamPtr getParam(
    const Inscoper::SubDeviceId & subDeviceId
)

Get the status parameter by sub-device ID.

Parameters:

subDeviceId : The sub-device ID of the desired parameter

Return: The status parameter, or null if not found

Retrieves a specific status parameters associated with the given sub-device ID.

function hasParamValue¶

bool hasParamValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Check if the status parameter has a value.

Parameters:

subDeviceId : The sub-device ID to check

Exceptions:

InscoperException If an error occurs

Return: True if the parameter has a value, false otherwise

Checks if the status parameter associated with the given sub-device ID exists and has at least a value assigned.

function getParamStringValue¶

std::string getParamStringValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get string value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The string value

Retrieves the value of the status parameter associated with the sub-device ID as a string.

function getParamUnsignedCharValue¶

unsigned char getParamUnsignedCharValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get unsigned char value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The unsigned char value

Retrieves the value of the status parameter associated with the sub-device ID as an unsigned char.

function getParamCharValue¶

char getParamCharValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get char value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The char value

Retrieves the value of the status parameter associated with the sub-device ID as a char.

function getParamUnsignedShortValue¶

unsigned short getParamUnsignedShortValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get unsigned short value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The unsigned short value

Retrieves the value of the status parameter associated with the sub-device ID as an unsigned short.

function getParamShortValue¶

short getParamShortValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get short value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The short value

Retrieves the value of the status parameter associated with the sub-device ID as a short.

function getParamUnsignedIntValue¶

unsigned int getParamUnsignedIntValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get unsigned int value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The unsigned int value

Retrieves the value of the status parameter associated with the sub-device ID as an unsigned int.

function getParamIntValue¶

int getParamIntValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get int value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The int value

Retrieves the value of the status parameter associated with the sub-device ID as an int.

function getParamUnsignedLongValue¶

unsigned long long int getParamUnsignedLongValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get unsigned long long value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The unsigned long long value

Retrieves the value of the status parameter associated with the sub-device ID as an unsigned long long.

function getParamLongValue¶

long long int getParamLongValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get long long value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The long long value

Retrieves the value of the status parameter associated with the sub-device ID as a long long.

function getParamFloatValue¶

float getParamFloatValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get float value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The float value

Retrieves the value of the status parameter associated with the sub-device ID as a float.

function getParamDoubleValue¶

double getParamDoubleValue(
    const Inscoper::SubDeviceId & subDeviceId
)

Get double value.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or conversion fails

Return: The double value

Retrieves the value of the status parameter associated with the sub-device ID as a double.

function getValueType¶

Inscoper::EParamType getValueType(
    const Inscoper::SubDeviceId & subDeviceId
)

Get value type.

Parameters:

subDeviceId : The sub-device ID of the parameter

Exceptions:

InscoperException If parameter is missing or type cannot be determined

Return: The parameter type of the value

Retrieves the type of the value for the status parameter associated with the sub-device ID.

function getTags¶

const std::vector< std::string > & getTags() const

Get tag list.

Return: The list of tags

Retrieves the list of tags associated with this status.

function addTag¶

void addTag(
    const std::string & tag
)

Add a tag.

Parameters:

tag : The tag to add

Adds a single tag to the status.

function addTags¶

void addTags(
    const std::vector< std::string > & tagList
)

Add multiple tags.

Parameters:

tagList : The list of tag

Adds a list of tags to the status.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId
)

Add status parameter without value.

Parameters:

subDeviceId : The sub-device ID for the new parameter

Exceptions:

InscoperException If an error occurs

Adds a status parameter for the given sub-device ID without assigning a value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    const std::string & value
)

Add string status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The string value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a string value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned char value
)

Add unsigned char status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The unsigned char value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with an unsigned char value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    char value
)

Add char status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The char value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a char value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short value
)

Add unsigned short status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The unsigned short value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with an unsigned short value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    short value
)

Add short status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The short value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a short value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned int value
)

Add unsigned int status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The unsigned int value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with an unsigned int value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    int value
)

Add int status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The int value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with an int value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned long long int value
)

Add unsigned long long status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The unsigned long long value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with an unsigned long long value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    long long int value
)

Add long long status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The long long value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a long long value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    float value
)

Add float status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The float value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a float value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    double value
)

Add double status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The double value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a double value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    bool value
)

Add boolean status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The boolean value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a boolean value.

function addParam¶

void addParam(
    const Inscoper::SubDeviceId & subDeviceId,
    const char * value
)

Add C-string status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
value : The C-string value

Exceptions:

InscoperException If an error occurs

Adds a status parameter with a C-string value.

function addParam¶

void addParam(
    const Inscoper::StatusParamPtr & newParam
)

Add existing status parameter.

Parameters:

newParam : The status parameter to add

Exceptions:

InscoperException If an error occurs

Adds an existing status parameter to the status.

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    const std::string & value
)

Add tagged string status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The string value

Exceptions:

InscoperException If an error occurs

Adds a tagged status parameter with a string value.

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    unsigned char value
)

Add tagged unsigned char status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The unsigned char value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    char value
)

Add tagged char status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The optimization tag
value : The char value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    unsigned short value
)

Add tagged unsigned short status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The unsigned short value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    short value
)

Add tagged short status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The short value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    unsigned int value
)

Add tagged unsigned int status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The unsigned int value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    int value
)

Add tagged int status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The int value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    unsigned long long int value
)

Add tagged unsigned long long status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The unsigned long long value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    long long int value
)

Add tagged long long status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The long long value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    float value
)

Add tagged float status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The float value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    double value
)

Add tagged double status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The double value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    bool value
)

Add tagged boolean status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The boolean value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    const char * value
)

Add tagged C-string status parameter.

Parameters:

subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The C-string value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    const std::string & value
)

Add indexed tagged string status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The string value

Exceptions:

InscoperException If an error occurs

Adds a parameter with index, tag, and string value.

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    unsigned char value
)

Add indexed tagged unsigned char status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The unsigned char value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    char value
)

Add indexed tagged char status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The char value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    unsigned short value
)

Add indexed tagged unsigned short parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The unsigned short value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    short value
)

Add indexed tagged short status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The short value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    unsigned int value
)

Add indexed tagged unsigned int status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The unsigned int value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    int value
)

Add indexed tagged int status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The int value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    unsigned long long int value
)

Add indexed tagged unsigned long long status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The unsigned long long value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    long long int value
)

Add indexed tagged long long status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The long long value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    float value
)

Add indexed tagged float status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The float value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    double value
)

Add indexed tagged double status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The double value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    bool value
)

Add indexed tagged boolean status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The boolean value

Exceptions:

InscoperException If an error occurs

function addMultiParam¶

void addMultiParam(
    unsigned short index,
    const Inscoper::SubDeviceId & subDeviceId,
    unsigned short tag,
    const char * value
)

Add indexed tagged C-string status parameter.

Parameters:

index : The value index
subDeviceId : The sub-device ID for the parameter
tag : The tag
value : The C-string value

Exceptions:

InscoperException If an error occurs

function containsParam¶

bool containsParam(
    const Inscoper::SubDeviceId & subDeviceId
)

Check if status parameter exists.

Parameters:

subDeviceId : The sub-device ID to check

Return: True if the parameter exists, false otherwise

Verifies if a status parameter with the given sub-device ID exists in the status.

function removeParam¶

void removeParam(
    const Inscoper::SubDeviceId & subDeviceId
)

Remove status parameter.

Parameters:

subDeviceId : The sub-device ID of the parameter to remove

Removes the status parameter identified by the sub-device ID from the status.

function equals¶

virtual bool equals(
    const std::shared_ptr< Status > & other
)

Check equality.

Parameters:

other : The status object to compare with

Return: True if equal, false otherwise

Compares this status with another for equality. Tests if all status parameters are equal.

function getHash¶

virtual size_t getHash()

Get hash.

Return: The hash code

Calculates a hash code for this status.

function getInternal¶

std::shared_ptr< Core::InternalStatus > getInternal()

Get internal object.

Return: The internal status

Internal use only. Retrieves the internal implementation object.

Updated on 2026-04-02 at 10:55:36 +0200